# Terwitch - Minimal terminal Twitch client

## Dependencies

1. [mpv](https://github.com/mpv-player/mpv) with capabilities for playing twitch streams ([yt-dlp](https://github.com/yt-dlp/yt-dlp) recommended). You can test this by running `mpv https://www.twitch.tv/STREAMER_NAME`;
2. [twitch-tui](https://github.com/Xithrius/twitch-tui) twitch specific IRC client built in Rust, check their repo for installation instructions;
3. [twiins](https://notabug.org/ropemann/twiins) minimal twitch information gatherer that can be used from the terminal

After the above dependencies are met, Terwitch should be ready for installation

## Installation

1. `git clone https://notabug.org/ropemann/terwitch.git`
2. `cd terwitch`
3. `make setup` (creates an empty streamers_file, optional if you already have one)
4. `sudo make install`

## Uninstallation

1. `cd terwitch`
2. `make teardown` (optional, in case you also want to delete your streamers_file)
3. `sudo uninstall`

## Usage

    Usage:
        terwitch <flags> <args>
    Flags:
        -c             Read streamers_file and check which streamers are online
        -C <streamer>  Connect to streamer's chat only
        -v <streamer>  View streamer's stream only
        -V <streamer>  View streamer's chat and connect to streamer's chat
        -a <streamer>  Add streamer to streamers_file
        -r <streamer>  Remove streamer from streamers_file

    Launch without flags to print this message again

## Inspiration & thanks

Maintainers and contributors of:  
[mpv](https://github.com/mpv-player/mpv)  
[yt-dlp](https://github.com/yt-dlp/yt-dlp)  
[twitch-tui](https://github.com/Xithrius/twitch-tui)

## License

This software is licensed under GNU GPL.
